Repository navigation
Document browser location controls - #602
Open
tnsardesai wants to merge 12 commits into
Open
tnsardesai wants to merge 12 commits into
tnsardesai wants to merge 12 commits into
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
tnsardesai
force-pushed
the
hypeship/browser-location-docs
branch
from
October 9, 2026 08:41
3ff01b8 to
4dff833
Compare
tnsardesai
marked this pull request as ready for review
October 9, 2026 22:54
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 032fb40. Configure here.
Location is set explicitly per session; omitted or cleared fields use the default for the browser's region. Proxy-based selection is not documented until it ships.
tnsardesai
force-pushed
the
hypeship/browser-location-docs
branch
from
October 15, 2026 19:09
8d2b86a to
ad504ba
Compare
Sayan-
requested changes
Oct 19, 2026
| The setting applies across browser contexts, pages, frames, workers, `Intl`, `navigator.language`, `navigator.languages`, and future `Accept-Language` headers. Updating it doesn't restart Chromium or reload pages. | ||
|
|
||
| <Note> | ||
| Location controls timezone and language behavior. It doesn't set geolocation coordinates, grant geolocation permission, change the system clock, translate browser UI, or guarantee a bot-detection outcome. KERNEL doesn't derive location from a browser's proxy; to match a proxy's country, set the location explicitly. |
Contributor
There was a problem hiding this comment.
KERNEL doesn't derive location from a browser's proxy; to match a proxy's country, set the location explicitly.
just flagging - not sure we need to expose this internal language externally
|
|
||
| <CodeGroup> | ||
| ```typescript TypeScript | ||
| const browser = await kernel.browsers.update('01j8m3w6q2d7av9n5k4f1p8c', { |
Contributor
There was a problem hiding this comment.
nit - can't remember if we typically hardcode a session id in our code examples like this
| ``` | ||
| </CodeGroup> | ||
|
|
||
| PATCH semantics are field-specific: |
Contributor
There was a problem hiding this comment.
nits
- weird to say
PATCHrather than update - these should perhaps just be comments inlined in the code blocks rather than after the fact
Comment on lines
+100
to
+115
| ## Read effective location | ||
|
|
||
| Browser responses include the effective values and where each came from: | ||
|
|
||
| ```json | ||
| { | ||
| "location": { | ||
| "timezone": "America/Los_Angeles", | ||
| "locale": "en-US", | ||
| "timezone_source": "override", | ||
| "locale_source": "metro" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| `timezone_source` and `locale_source` are `override` for a value set on the session and `metro` for the default of the browser's region. The fields are independent, so their sources can differ. |
Contributor
There was a problem hiding this comment.
seems unnecessary to expose basic API values in user docs
Comment on lines
+119
to
+125
| - New pages, frames, workers, and network contexts start with the current location. | ||
| - Existing pages and workers receive the update without a reload. | ||
| - Existing `Intl` formatter objects and application-level caches can retain values captured before the update. Create a new formatter when you need the latest default. | ||
| - Future requests use the updated language preference. Requests already in flight aren't rewritten. | ||
| - Customer CDP emulation remains separate from the session default and can temporarily override what a particular target reports. | ||
| - Location overrides last only for the browser session, and profiles don't save them. | ||
| - A pooled browser released with `reuse: true` keeps its location for the next acquirer, as it keeps cookies and open tabs. Release with `reuse: false` to get a fresh browser. |
Contributor
There was a problem hiding this comment.
should use to use plainer, human facing language. don't think these would necessarily make sense to a first time reader
Drop the proxy note and the response source values, show updates against the created browser's session ID with the update rules as code comments, and describe how changes take effect in plainer language.
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
browsers/location.mdx: setting, updating, clearing, and reading a browser session's timezone and locale.Why
How
null/Noneclears it to the region default.en-us→en-US,iw-IL→he-IL) and theinvalid_browser_locationerror.reuse: truekeeps its location, like cookies and tabs;reuse: falsegives a fresh browser.Context
Testing & Visuals
git diff --checkis clean.mintlify devwas not run locally.browsers/regionsis indocs.jsonnavigation. Is that intended?Note
Low Risk
Documentation-only changes with no runtime or API behavior in this repo.
Overview
Adds a Browser Location guide that documents how to set, update, clear, and read a session’s timezone and locale (region defaults vs per-field overrides via omit / string /
null/None), including validation/normalization,invalid_browser_location, response*_sourcefields, runtime scope (tabs,Intl, Playwright precedence), and poolreusebehavior—with TypeScript and Python examples.The Configure intro now links Location under “More browser settings” alongside Regions and related browser options.
Reviewed by Cursor Bugbot for commit 4d9d122. Bugbot is set up for automated code reviews on this repo. Configure here.